docs(ai): add Pi to manual MCP setup#285
Conversation
Pi (pi.dev) has no built-in MCP support, so the generic 'use the shared server entry' guidance does not work without an adapter. Add a dedicated Pi tab documenting the pi-mcp-adapter extension plus the ~/.pi/agent/mcp.json server entry, and note the no-built-in-MCP case in the 'Other MCP-compatible agents' section.
|
|
@jonathan-nicoletti is attempting to deploy a commit to the Proof Team on Vercel. A member of the Team first needs to authorize it. |
📝 WalkthroughWalkthroughThis pull request adds Pi as a supported per-agent configuration target in the manual MCP setup documentation. The agent tabs list was expanded to include Pi, and a new Pi configuration section was added with adapter installation steps, config file path, wrapper key, and configuration examples with optional adapter-specific fields. ChangesPi Agent Configuration Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
apps/docs/content/docs/ai/manual-mcp-setup.mdx (1)
217-220: 💤 Low valueConsider clarifying the adapter options explanation.
The phrase "not part of the shared server entry" might cause readers to question whether
lifecycleanddirectToolsshould be at a different location in the JSON structure. The current phrasing is technically accurate (they're adapter-specific extensions, not shared across all agents), but could be misread.Consider rewording slightly for clarity:
📝 Suggested clarification
- The `lifecycle` and `directTools` fields are adapter options, not part of the shared - server entry: `lifecycle: "eager"` connects to your open FileMaker file at startup, and - `directTools: true` registers the ProofKit tools as first-class Pi tools instead of - hiding them behind a proxy. Both are optional. + The `lifecycle` and `directTools` fields are Pi-adapter-specific options that extend the + shared server entry: `lifecycle: "eager"` connects to your open FileMaker file at startup, and + `directTools: true` registers the ProofKit tools as first-class Pi tools instead of + hiding them behind a proxy. Both are optional.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@apps/docs/content/docs/ai/manual-mcp-setup.mdx` around lines 217 - 220, Reword the sentence so it's explicit that lifecycle and directTools are adapter-specific configuration keys inside the adapter's config object (not top-level/shared-agent settings); mention that lifecycle: "eager" controls when the adapter connects to the FileMaker file and directTools: true exposes ProofKit tools as native Pi tools, and clarify both are optional—replace the phrase "not part of the shared server entry" with something like "are adapter-specific options placed inside the adapter configuration (not global/shared agent settings)" and ensure both `lifecycle` and `directTools` are referenced by name in that sentence for clarity.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@apps/docs/content/docs/ai/manual-mcp-setup.mdx`:
- Around line 217-220: Reword the sentence so it's explicit that lifecycle and
directTools are adapter-specific configuration keys inside the adapter's config
object (not top-level/shared-agent settings); mention that lifecycle: "eager"
controls when the adapter connects to the FileMaker file and directTools: true
exposes ProofKit tools as native Pi tools, and clarify both are optional—replace
the phrase "not part of the shared server entry" with something like "are
adapter-specific options placed inside the adapter configuration (not
global/shared agent settings)" and ensure both `lifecycle` and `directTools` are
referenced by name in that sentence for clarity.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 611a27b7-7d33-417e-b645-afd07be872b3
📒 Files selected for processing (1)
apps/docs/content/docs/ai/manual-mcp-setup.mdx
|
Thanks for the suggestion, but I think this example is a bit too complex for our docs. I suspect the type of user who is already using Pi would already know how to connect an MCP server, and we would rather promote simpler tools to developers at this time. |
What
Adds Pi to the Manual MCP Setup docs page (
apps/docs/content/docs/ai/manual-mcp-setup.mdx):Why
Pi is unique among the listed agents: it ships no built-in MCP support, so the page's existing generic advice ("use the shared server entry") doesn't work on its own. Pi users need to install a community MCP-bridge extension first, then point it at
proofkit-mcp.Details
The Pi tab documents:
pi install npm:pi-mcp-adapter~/.pi/agent/mcp.jsonusing the standardmcpServerswrapper key — same shape as the other agents.lifecycle: "eager"anddirectTools: true), clearly called out as adapter options rather than part of the shared server entry.Verification
Set this up locally end-to-end: installed
pi-mcp-adapter, added theproofkit-mcpentry to~/.pi/agent/mcp.json, restarted Pi, and confirmed the connection —connectedFilesreturned the open file andlayout_metadatareturned the full layout catalog. The 16 ProofKit tools register as first-class Pi tools withdirectTools: true.Docs-only change;
@proofkit/docsis in the changeset ignore list, so no changeset included.Summary by CodeRabbit
Documentation